Prizm Content Connect
Configuring Log File Locations
Working with the Prizm Platform Services > Prizm Services How To's > Configuring Log File Locations

The Prizm Platform Services are made up of several different processes, each of which create and maintain their own logs. The logs are invaluable for diagnosing issues with the services if they arise. If you find yourself in this situation, please see the topic How to Package Log Files for Product Support to expedite your support request.

Each logging process has a default log file path that you can change if needed. This topic will discuss each process one by one and explain how to configure where log files are written.

Watchdog

The Watchdog uses the following default log file paths:

The Watchdog will only keep up to 7 days of log files. To change where the Watchdog log files are written:

  1. Open the watchdog config file:
  1. In the paths section, change the app_log_dir property to the path of a valid directory. Both relative and absolute path are supported but a forward slash should always be used as the directory separator, even on Windows. A relative directory will be relative to the Prizm Platform Services install directory, which is C:\Prizm\ on Windows and /usr/share/prizm on Linux.
Example
Copy Code 
"paths": {
      ...
        "app_log_dir": [ "C:/some/custom/path" ],
      ...
},

Entry Points

The Server and Cloud Entry Points uses the following default log file paths:

The Entry Points will only keep up to 7 days of log files. To change where the Entry Points log files are written:

  1. Open the config file:
  1. Change the logFileName property so that the directory part of the existing path is the value you choose. It is recommended that you leave the filename portion of the path as the default value. The new log file directory must be valid and exist.
Example
Copy Code 
{
      ...
        "logFileName": "C:/some/custom/path/plb.log",
      ...
}

PCCIS

The PCCIS service uses the following default log file paths:

The PCCIS service will only keep up to 7 days of log files. To change where the PCCIS service log file are written:

  1. Open the PCCIS config file:
  1. In the target element, change the fileName property so that the directory part of the existing path is the value you choose. It is recommended that you leave the filename portion of the path as the default value.
  2. In the target element, change the archiveFileName property so that the directory part of the existing path is the value you choose. It is recommended that you leave the filename portion of the path as the default value.
Example
Copy Code 
<target … fileName="C:/some/custom/path/ImagingServices.log"  archiveFileName="C:/some/custom/path/ImagingServices-{#}.log" … />

PDF Conversion Service

The PDF Conversion Service uses the following default log file paths:

The PDF Conversion Service will only keep up to 7 days of log files. To change where the PDF Conversion Service log files are written:

  1. Open the config file:
  1. Change the logFileLocation property so that the directory part of the existing path is the value you choose. It is recommended that you leave the filename portion of the path as the default value. The new log file directory must be valid and exist.
Example
Copy Code 
{
      ...
        "logFileLocation": "C:/some/custom/path/PDFConversionService.log",
      ...
}

Raster Conversion Service

The Raster Conversion Service uses the following default log file paths:

The Raster Conversion Service will only keep up to 7 days of log files. To change where the Raster Conversion Service log files are written:

  1. Open the config file:
  1. Change the logFileLocation property so that the directory part of the existing path is the value you choose. It is recommended that you leave the filename portion of the path as the default value. The new log file directory must be valid and exist.
Example
Copy Code 
{
      ...
        "logFileLocation": "C:/some/custom/path/RasterConversionService.log",
      ...
}

Proxy Server Service

The Proxy Server Service uses the following default log file paths:

The Proxy Server Service will only keep up to 7 days of log files. To change where the Raster Conversion Service log files are written:

  1. Open the config file:
  1. Change the jrunner.logfile property so that the directory part of the existing path is the value you choose. It is recommended that you leave the filename portion of the path as the default value.
Example
Copy Code 
jrunner.logfile=C:/some/custom/path/proxyserver-YYYYMMDD.log"

Nginx (Linux Only)

If you run PCC on Linux, Nginx is used to host the HTTP API for PCCIS. The proper version of Nginx is included with the product and set up for you during installation, but we do not change the default Nginx logging rules.

On a production machine, you will want to configure:

  1. Where Nginx stores its log files, and
  2. Ensure that Nginx log files are properly rotated and pruned.

Changing Nginx Log File Locations

Nginx offers some basic logging features commonly found in web servers such as enabling logs to record access and error history, as well as the ability to adjust the format of the content written to the logs.

PCC enables both the access log and error log for Nginx. You can adjust where these logs are stored by editing this config file:

Example
Copy Code 
/usr/share/prizm/nginx/nginx.conf

In this file, you can assign the paths you want for the error_log and access_log. In the excerpt below, you would alter the two paths which appear after error_log and access_log:

Example
Copy Code 
error_log /usr/share/prizm/nginx/logs/error.log warn;
…

   log_format  main  '$remote_addr - $remote_user [$time_local] "$request" '
                     '$status $body_bytes_sent "$http_referer" '
                     '"$http_user_agent" "$http_x_forwarded_for" $request_time';

   access_log /usr/share/prizm/nginx/logs/access.log main;
…

For more information about Nginx logging, please see the Nginx docs for the log module.

Limiting the Amount of Nginx Log Data That is Kept

By default, Nginx will continue writing to a single access log and a single error log for its entire lifetime. Over time these logs can grow very large to a point where they start consuming a significant about of storage space.

Fortunately, most Linux distributions include a utility called logrotate to help with this problem. PCC includes a logrotate configuration that will cause the Nginx access and error logs to be rotated daily, with the old logs being GZIP compressed and automatically deleted after 7 days. The logrotate configuration that PCC provides can be found in the following file:

Example
Copy Code 
/etc/logrotate.d/prizm

You may edit the file if you would like to adjust the log rotation settings for Nginx. See the logrotate man page for more information about available logrotate settings and their meanings.

Restart PCC (and IIS on Windows) for Logging Changes to Take Effect

 

 

©2014. Accusoft Corporation. All Rights Reserved.

Send Feedback